Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: Yarn package install in getting-started.md #2566

Merged
merged 5 commits into from
Sep 17, 2024

Conversation

DuYongLee
Copy link
Contributor

Because yarn is installed with add, not install, �I changed yarn install to yarn add.

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • fix bug about wrong document
  • New functionality

Test plan

How are these changes tested?
It just update for document

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

change from yarn install to yarn add
Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@tazarov tazarov changed the title Update getting-started.md [DOC]: Yarn package install in getting-started.md Jul 30, 2024
@tazarov
Copy link
Contributor

tazarov commented Jul 30, 2024

@DuYongLee, thanks for this.

making a tiny change to retrigger the GH PR checklist.
Copy link
Contributor

@tazarov tazarov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks again @DuYongLee

@tazarov tazarov added the documentation Improvements or additions to documentation label Jul 31, 2024
@DuYongLee
Copy link
Contributor Author

@tazarov Thanks for your checking. it had a conflict so I resolved it.

@DuYongLee DuYongLee requested a review from tazarov August 4, 2024 23:39
@jeffchuber jeffchuber self-assigned this Sep 16, 2024
@jeffchuber
Copy link
Contributor

@DuYongLee weird github issue where the test suite didnt run (cant merge without it...). - can you bump a commit to this to retrigger them? (add whitespace to a README or something) id be happy to do it but im on an airplane and the wifi is terrible :)

bump commit for runner
@DuYongLee
Copy link
Contributor Author

image

@jeffchuber I think this issue needs to be approved by tazarov or removed from reviewer.
I made a bump commit but there is no response.

@jeffchuber jeffchuber merged commit 152954c into chroma-core:main Sep 17, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants